Hugo MCP

Installation

Prerequisites

• Python 3.10+
• uv (Python package manager)
• Git (Highly recommended)

Installing the Hugo MCP Server

1. Clone the repository:

   git clone https://github.com/sunnycloudyang/hugo-mcp.git
   

2. Add server to your config (make sure uv has been installed before):

   {
        "mcpServers": {
            "hugo-mcp": {
                "command": "uv",
                "args": [
                    "--directory",
                    "/ABSOLUTE/PATH/TO/PARENT/FOLDER/hugo-mcp",
                    "run",
                    "main.py"
                ]
            }
        }
    }
   

   Remember to replace "/ABSOLUTE/PATH/TO/PARENT/FOLDER/hugo-mcp" to your installation path

3. Enalble this mcp server and try it!

Usage

The Hugo MCP server provides a set of tools that can be used to manage Hugo sites. Each tool has specific parameters and returns a structured response.

Troubleshooting

Common Issues

1. Hugo is not installed:

   • Use the install_hugo tool to install Hugo.

2. Git is not installed:

   • Use the install_git tool to install Git.

3. Theme installation fails:

   • Check if the theme URL is correct.
   • Make sure Git is installed for git submodules.
   • Make sure Go is installed for Hugo modules.
   • Read the theme's doc to check if there is sth. different

4. Preview server fails to start:

   • Check if the port is already in use.
   • Make sure the site path is correct.
   • Check your network

5. Build fails:

   • Check if the site path is correct.
   • Make sure all required dependencies are installed.

Getting Help

If you encounter any issues not covered in this documentation, please open an issue on the GitHub repository.